Skip to content

[v2] Improve example validation and corrections#10101

Open
ashovlin wants to merge 1 commit intoaws:v2from
ashovlin:shovlia/docs-validatation
Open

[v2] Improve example validation and corrections#10101
ashovlin wants to merge 1 commit intoaws:v2from
ashovlin:shovlia/docs-validatation

Conversation

@ashovlin
Copy link
Member

Issue #, if available: N/A

Description of changes:

This improves the validation we do in the existing tests/functional/docs/test_examples.py. Previously we were only testing the service and operation name.

Now, it runs the example commands through the appropriate parser for each. This will catch more issues: invalid syntax, invalid argument names, missing required parameters.

This also fixes the examples that fail for the updated test.

Note: I did not address examples that specify --cli-input-json/etc., it'll require more work to parse and validate those.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@ashovlin ashovlin added the documentation This is a problem with documentation. label Mar 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This is a problem with documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant